/*
 * 代号：凤凰
 * http://www.jphenix.org
 * 2014-06-13
 * V4.0
 */
package com.jphenix.standard.servlet.api;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Collection;
import java.util.Locale;
import java.util.Map;

import com.jphenix.standard.docs.ClassInfo;

/**
 * 页面反馈扩展接口
 * 
 * 2022-09-04 隔离了ServletApi，兼容新老Tomcat
 * 2022-09-05 合并了假反馈接口
 * 2022-09-07 将IResponse中高风险方法迁移到了IResponseManager接口中
 * 
 * @author 刘虻
 * 2012-7-30 上午9:08:46
 */
@ClassInfo({"2022-09-07 13:09","页面反馈扩展接口"})
public interface IResponse {
	
	/**
	 * 将信息头放入返回对象
	 * @param headerMap 信息头容器
	 * 2016年7月13日
	 * @author MBG
	 */
	void putHeaderMap(Map<String,String> headerMap);
	
    /**
     * 返回错误信息，如果有的话
     * @return 错误信息
     * 2017年3月1日
     * @author MBG
     */
    String getErrorMsg();
    
	/**
	 * 清除缓存
	 * 2017年4月28日
	 * @author MBG
	 */
	void clear();
	
    /**
     * 向浏览器输出错误信息，并跳转到指定的错误页面
     * 程序会解析错误页面中的动态内容
     * @param status          错误代码
     * @param req             页面请求（用于解析错误页面中的动态内容）
     * @throws IOException    异常
     * 2017年11月24日
     * @author MBG
     */
	void sendError(int status,IRequest req) throws IOException;

    /**
     * 向浏览器输出错误信息，并跳转到指定的错误页面
     * 程序会解析错误页面中的动态内容
     * @param status          错误代码
     * @param errorMsg        错误信息
     * @param req             页面请求（用于解析错误页面中的动态内容）
     * @throws IOException    异常
     * 2017年11月24日
     * @author MBG
     */
	void sendError(int status, String errorMsg,IRequest req) throws IOException;
	
	/**
	 * 获取返回的信息数据流
	 * @return 返回的信息数据流
	 * 2016年11月25日
	 * @author MBG
	 */
	ByteArrayOutputStream getData();
	
	//#region 以下是原标准接口中的方法
	
	/**
	 * 获取返回数据编码格式
	 * @return 返回数据编码格式
	 * 2022年8月22日
	 * @author MBG
	 */
    String getCharacterEncoding();

    /**
     * 获取内容类型
     * @return 内容类型
     * 2022年8月22日
     * @author MBG
     */
    String getContentType();

    /**
     * 获取输出流
     * @return 输出流
     * @throws IOException 异常
     * 2022年8月22日
     * @author MBG
     */
    ServletOutputStream iGetOutputStream() throws IOException;

    /**
     * 获取输出类
     * @return 输出类
     * @throws IOException 异常
     * 2022年8月22日
     * @author MBG
     */
    PrintWriter getWriter() throws IOException;

    /**
     * 设置输出数据编码
     * @param charset 输出数据编码
     * 2022年8月22日
     * @author MBG
     */
    void setCharacterEncoding(String charset);

    /**
     * 设置输出数据长度
     * @param len 输出数据长度
     * 2022年8月22日
     * @author MBG
     */
    void setContentLength(int len);

    /**
     * 设置输出数据长度
     * @param length 输出数据长度
     * 2022年8月22日
     * @author MBG
     */
    void setContentLengthLong(long length);

    /**
     * 设置内容类型
     * @param type 内容类型
     * 2022年8月22日
     * @author MBG
     */
    void setContentType(String type);

    /**
     * 设置缓存大小
     * @param size 缓存大小
     * 2022年8月22日
     * @author MBG
     */
    void setBufferSize(int size);

    /**
     * 获取当前缓存大小
     * @return 当前缓存大小
     * 2022年8月22日
     * @author MBG
     */
    int getBufferSize();

    /**
     * 刷新缓存
     * @throws IOException 异常
     * 2022年8月22日
     * @author MBG
     */
    void flushBuffer() throws IOException;

    /**
     * 重置缓存
     * 2022年8月22日
     * @author MBG
     */
    void resetBuffer();

    /**
     * 是否已经提交数据
     * @return 是否已经提交数据
     * 2022年8月22日
     * @author MBG
     */
    boolean isCommitted();

    /**
     * 重置
     * 2022年8月22日
     * @author MBG
     */
    void reset();

    /**
     * 设置语言信息
     * @param loc 语言信息
     * 2022年8月22日
     * @author MBG
     */
    void setLocale(Locale loc);

    /**
     * 返回语言信息
     * @return 语言信息
     * 2022年8月22日
     * @author MBG
     */
    Locale getLocale();
    
    /**
     * 添加Cookie
     * @param cookie Cookie
     * 2022年8月24日
     * @author MBG
     */
    void addCookie(ICookie cookie);

    /**
     * 创建cookie
     * @param name 名字
     * @return cookie
     * 2022年8月27日
     * @author MBG
     */
    ICookie createCookie(String name,String value);
    
    /**
     * 是否存在指定报文头
     * @param name 报文头名
     * @return 是否存在指定报文头
     * 2022年8月24日
     * @author MBG
     */
    boolean containsHeader(String name);

    /**
     * 对字符串进行编码
     * @param url 待编码URL字符串
     * @return    编码后的字符串
     * 2022年8月24日
     * @author MBG
     */
    String encodeURL(String url);

    /**
     * 对url进行编码（该方法编码后的url可以跨应用）
     * @param url 待编码URL字符串
     * @return    编码后的字符串
     * 2022年8月24日
     * @author MBG
     */
    String encodeRedirectURL(String url);

    /**
     * 发送错误代码
     * @param sc           错误代码
     * @param msg          错误信息
     * @throws IOException 异常
     * 2022年8月24日
     * @author MBG
     */
    void sendError(int sc, String msg) throws IOException;

    /**
     * 发送错误代码
     * @param sc           错误代码
     * @throws IOException 异常
     * 2022年8月24日
     * @author MBG
     */
    void sendError(int sc) throws IOException;

    /**
     * 重定向
     * @param location     重定向url
     * @throws IOException 异常
     * 2022年8月24日
     * @author MBG
     */
    void sendRedirect(String location) throws IOException;

    /**
     * 设置日期型报文头
     * @param name  报文头名
     * @param date  值
     * 2022年8月24日
     * @author MBG
     */
    void setDateHeader(String name, long date);

    /**
     * 添加日期型报文头值
     * @param name  报文头名
     * @param date  值
     * 2022年8月24日
     * @author MBG
     */
    void addDateHeader(String name, long date);

    /**
     * 设置报文头值
     * @param name   报文头名
     * @param value  值
     * 2022年8月24日
     * @author MBG
     */
    void setHeader(String name, String value);

    /**
     * 添加报文头值
     * @param name  报文头名
     * @param value 值
     * 2022年8月24日
     * @author MBG
     */
    void addHeader(String name, String value);

    /**
     * 设置整型报文头值
     * @param name  报文头名
     * @param value 报文头值
     * 2022年8月24日
     * @author MBG
     */
    void setIntHeader(String name, int value);

    /**
     * 添加整型报文头值
     * @param name  报文头名
     * @param value 值
     * 2022年8月24日
     * @author MBG
     */
    void addIntHeader(String name, int value);

    /**
     * 设置返回状态码
     * @param sc 状态码
     * 2022年8月24日
     * @author MBG
     */
    void setStatus(int sc);

    /**
     * 获取返回状态码
     * @return 返回状态码
     * 2022年8月24日
     * @author MBG
     */
    int getStatus();

    /**
     * 获取指定报文头值
     * @param name 报文头名
     * @return     值
     * 2022年8月24日
     * @author MBG
     */
    String getHeader(String name);

    /**
     * 获取指定报文头值集合
     * @param name 报文头名
     * @return     报文头值
     * 2022年8月24日
     * @author MBG
     */
    Collection<String> getHeaders(String name);

    /**
     * 获取所有报文头名集合
     * @return 所有报文头名集合
     * 2022年8月24日
     * @author MBG
     */
    Collection<String> getHeaderNames();

    /**
     * Status code (100) indicating the client can continue.
     */
    int SC_CONTINUE = 100;

    /**
     * Status code (101) indicating the server is switching protocols according
     * to Upgrade header.
     */
    int SC_SWITCHING_PROTOCOLS = 101;

    /**
     * Status code (200) indicating the request succeeded normally.
     */
    int SC_OK = 200;

    /**
     * Status code (201) indicating the request succeeded and created a new
     * resource on the server.
     */
    int SC_CREATED = 201;

    /**
     * Status code (202) indicating that a request was accepted for processing,
     * but was not completed.
     */
    int SC_ACCEPTED = 202;

    /**
     * Status code (203) indicating that the meta information presented by the
     * client did not originate from the server.
     */
    int SC_NON_AUTHORITATIVE_INFORMATION = 203;

    /**
     * Status code (204) indicating that the request succeeded but that there
     * was no new information to return.
     */
    int SC_NO_CONTENT = 204;

    /**
     * Status code (205) indicating that the agent <em>SHOULD</em> reset the
     * document view which caused the request to be sent.
     */
    int SC_RESET_CONTENT = 205;

    /**
     * Status code (206) indicating that the server has fulfilled the partial
     * GET request for the resource.
     */
    int SC_PARTIAL_CONTENT = 206;

    /**
     * Status code (300) indicating that the requested resource corresponds to
     * any one of a set of representations, each with its own specific location.
     */
    int SC_MULTIPLE_CHOICES = 300;

    /**
     * Status code (301) indicating that the resource has permanently moved to a
     * new location, and that future references should use a new URI with their
     * requests.
     */
    int SC_MOVED_PERMANENTLY = 301;

    /**
     * Status code (302) indicating that the resource has temporarily moved to
     * another location, but that future references should still use the
     * original URI to access the resource. This definition is being retained
     * for backwards compatibility. SC_FOUND is now the preferred definition.
     */
    int SC_MOVED_TEMPORARILY = 302;

    /**
     * Status code (302) indicating that the resource reside temporarily under a
     * different URI. Since the redirection might be altered on occasion, the
     * client should continue to use the Request-URI for future
     * requests.(HTTP/1.1) To represent the status code (302), it is recommended
     * to use this variable.
     */
    int SC_FOUND = 302;

    /**
     * Status code (303) indicating that the response to the request can be
     * found under a different URI.
     */
    int SC_SEE_OTHER = 303;

    /**
     * Status code (304) indicating that a conditional GET operation found that
     * the resource was available and not modified.
     */
    int SC_NOT_MODIFIED = 304;

    /**
     * Status code (305) indicating that the requested resource <em>MUST</em> be
     * accessed through the proxy given by the <code><em>Location</em></code>
     * field.
     */
    int SC_USE_PROXY = 305;

    /**
     * Status code (307) indicating that the requested resource resides
     * temporarily under a different URI. The temporary URI <em>SHOULD</em> be
     * given by the <code><em>Location</em></code> field in the response.
     */
    int SC_TEMPORARY_REDIRECT = 307;

    /**
     * Status code (400) indicating the request sent by the client was
     * syntactically incorrect.
     */
    int SC_BAD_REQUEST = 400;

    /**
     * Status code (401) indicating that the request requires HTTP
     * authentication.
     */
    int SC_UNAUTHORIZED = 401;

    /**
     * Status code (402) reserved for future use.
     */
    int SC_PAYMENT_REQUIRED = 402;

    /**
     * Status code (403) indicating the server understood the request but
     * refused to fulfill it.
     */
    int SC_FORBIDDEN = 403;

    /**
     * Status code (404) indicating that the requested resource is not
     * available.
     */
    int SC_NOT_FOUND = 404;

    /**
     * Status code (405) indicating that the method specified in the
     * <code><em>Request-Line</em></code> is not allowed for the resource
     * identified by the <code><em>Request-URI</em></code>.
     */
    int SC_METHOD_NOT_ALLOWED = 405;

    /**
     * Status code (406) indicating that the resource identified by the request
     * is only capable of generating response entities which have content
     * characteristics not acceptable according to the accept headers sent in
     * the request.
     */
    int SC_NOT_ACCEPTABLE = 406;

    /**
     * Status code (407) indicating that the client <em>MUST</em> first
     * authenticate itself with the proxy.
     */
    int SC_PROXY_AUTHENTICATION_REQUIRED = 407;

    /**
     * Status code (408) indicating that the client did not produce a request
     * within the time that the server was prepared to wait.
     */
    int SC_REQUEST_TIMEOUT = 408;

    /**
     * Status code (409) indicating that the request could not be completed due
     * to a conflict with the current state of the resource.
     */
    int SC_CONFLICT = 409;

    /**
     * Status code (410) indicating that the resource is no longer available at
     * the server and no forwarding address is known. This condition
     * <em>SHOULD</em> be considered permanent.
     */
    int SC_GONE = 410;

    /**
     * Status code (411) indicating that the request cannot be handled without a
     * defined <code><em>Content-Length</em></code>.
     */
    int SC_LENGTH_REQUIRED = 411;

    /**
     * Status code (412) indicating that the precondition given in one or more
     * of the request-header fields evaluated to false when it was tested on the
     * server.
     */
    int SC_PRECONDITION_FAILED = 412;

    /**
     * Status code (413) indicating that the server is refusing to process the
     * request because the request entity is larger than the server is willing
     * or able to process.
     */
    int SC_REQUEST_ENTITY_TOO_LARGE = 413;

    /**
     * Status code (414) indicating that the server is refusing to service the
     * request because the <code><em>Request-URI</em></code> is longer than the
     * server is willing to interpret.
     */
    int SC_REQUEST_URI_TOO_LONG = 414;

    /**
     * Status code (415) indicating that the server is refusing to service the
     * request because the entity of the request is in a format not supported by
     * the requested resource for the requested method.
     */
    int SC_UNSUPPORTED_MEDIA_TYPE = 415;

    /**
     * Status code (416) indicating that the server cannot serve the requested
     * byte range.
     */
    int SC_REQUESTED_RANGE_NOT_SATISFIABLE = 416;

    /**
     * Status code (417) indicating that the server could not meet the
     * expectation given in the Expect request header.
     */
    int SC_EXPECTATION_FAILED = 417;

    /**
     * Status code (500) indicating an error inside the HTTP server which
     * prevented it from fulfilling the request.
     */
    int SC_INTERNAL_SERVER_ERROR = 500;

    /**
     * Status code (501) indicating the HTTP server does not support the
     * functionality needed to fulfill the request.
     */
    int SC_NOT_IMPLEMENTED = 501;

    /**
     * Status code (502) indicating that the HTTP server received an invalid
     * response from a server it consulted when acting as a proxy or gateway.
     */
    int SC_BAD_GATEWAY = 502;

    /**
     * Status code (503) indicating that the HTTP server is temporarily
     * overloaded, and unable to handle the request.
     */
    int SC_SERVICE_UNAVAILABLE = 503;

    /**
     * Status code (504) indicating that the server did not receive a timely
     * response from the upstream server while acting as a gateway or proxy.
     */
    int SC_GATEWAY_TIMEOUT = 504;

    /**
     * Status code (505) indicating that the server does not support or refuses
     * to support the HTTP protocol version that was used in the request
     * message.
     */
    int SC_HTTP_VERSION_NOT_SUPPORTED = 505;
    
	//#endregion
}
